/**
 *       Copyright (c) 2012 Lukas Zaruba
 *
 *   This file is part of Robot Playground.
 *
 *   Robot Playground is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   Robot Playground is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with Robot Playground. If not, see <http://www.gnu.org/licenses/>.
 */
package net.zarubsys.robotplayground.core.device;

import net.zarubsys.robotplayground.core.Environment;

/**
 * IDevice
 * 
 * Implement this interface if you want to create new Device
 * Do not forget to  contribute it to the proper extension point.
 * Consult the Developer's Guide for details.
 * 
 * Implementation must provide public non-parametric constructor!
 * 
 * You can use {@link EmptyDeviceConfiguration} if you don't want
 * to create your own.
 *
 * @author Lukas Zaruba, lukas.zaruba@gmail.com
 */
public interface IDevice<T extends IDeviceConfiguration> {
	
	/**
	 * @return id of the device. Must be unique so thing ahead
	 * and create really unique id.
	 */
	String getId();
	
	/**
	 * This method gets called after the instantiation.
	 * @param configuration represents an instance of configuration by which
	 * your class is typed.
	 * @param env instance of the Environment common for objects of one
	 * running session.
	 */
	void init(T configuration, Environment env);
	
	/**
	 * This method gets called once the running session is terminated.
	 * Be sure to release all resources.
	 */
	void close();

}

